Sourced from mkdocstrings's releases.

0.28.0

0.28.0 - 2025-02-03

Compare with 0.27.0

Breaking Changes

Although the following changes are "breaking" in terms of public API, we didn't find any public use of these classes and methods on GitHub.

• mkdocstrings.extension.AutoDocProcessor.__init__(parser): Parameter was removed
• mkdocstrings.extension.AutoDocProcessor.__init__(md): Positional parameter was moved
• mkdocstrings.extension.AutoDocProcessor.__init__(config): Parameter was removed
• mkdocstrings.extension.AutoDocProcessor.__init__(handlers): Parameter kind was changed: positional or keyword -> keyword-only
• mkdocstrings.extension.AutoDocProcessor.__init__(autorefs): Parameter kind was changed: positional or keyword -> keyword-only
• mkdocstrings.extension.MkdocstringsExtension.__init__(config): Parameter was removed
• mkdocstrings.extension.MkdocstringsExtension.__init__(handlers): Positional parameter was moved
• mkdocstrings.extension.MkdocstringsExtension.__init__(autorefs): Positional parameter was moved
• mkdocstrings.handlers.base.Handlers.__init__(config): Parameter was removed
• mkdocstrings.handlers.base.Handlers.__init__(theme): Parameter was added as required
• mkdocstrings.handlers.base.Handlers.__init__(default): Parameter was added as required
• mkdocstrings.handlers.base.Handlers.__init__(inventory_project): Parameter was added as required
• mkdocstrings.handlers.base.Handlers.__init__(tool_config): Parameter was added as required

Similarly, the following parameters were renamed, but the methods are only called from our own code, using positional arguments.

• mkdocstrings.handlers.base.BaseHandler.collect(config): Parameter was renamed options
• mkdocstrings.handlers.base.BaseHandler.render(config): Parameter was renamed options

Finally, the following method was removed, but this is again taken into account in our own code:

• mkdocstrings.handlers.base.BaseHandler.get_anchors: Public object was removed

For these reasons, and because we're still in v0, we do not bump to v1 yet. See following deprecations.

Deprecations

mkdocstrings 0.28 will start emitting these deprecations warnings:

The handler argument is deprecated. The handler name must be specified as a class attribute.

Previously, the get_handler function would pass a handler (name) argument to the handler constructor. This name must now be set on the handler's class directly.

class MyHandler:
name = "myhandler"

The domain attribute must be specified as a class attribute.

The domain class attribute on handlers is now mandatory and cannot be an empty string.

... (truncated)

Sourced from mkdocstrings's changelog.

0.28.0 - 2025-02-03

Compare with 0.27.0

Breaking Changes

Although the following changes are "breaking" in terms of public API, we didn't find any public use of these classes and methods on GitHub.

• mkdocstrings.extension.AutoDocProcessor.__init__(parser): Parameter was removed
• mkdocstrings.extension.AutoDocProcessor.__init__(md): Positional parameter was moved
• mkdocstrings.extension.AutoDocProcessor.__init__(config): Parameter was removed
• mkdocstrings.extension.AutoDocProcessor.__init__(handlers): Parameter kind was changed: positional or keyword -> keyword-only
• mkdocstrings.extension.AutoDocProcessor.__init__(autorefs): Parameter kind was changed: positional or keyword -> keyword-only
• mkdocstrings.extension.MkdocstringsExtension.__init__(config): Parameter was removed
• mkdocstrings.extension.MkdocstringsExtension.__init__(handlers): Positional parameter was moved
• mkdocstrings.extension.MkdocstringsExtension.__init__(autorefs): Positional parameter was moved
• mkdocstrings.handlers.base.Handlers.__init__(config): Parameter was removed
• mkdocstrings.handlers.base.Handlers.__init__(theme): Parameter was added as required
• mkdocstrings.handlers.base.Handlers.__init__(default): Parameter was added as required
• mkdocstrings.handlers.base.Handlers.__init__(inventory_project): Parameter was added as required
• mkdocstrings.handlers.base.Handlers.__init__(tool_config): Parameter was added as required

Similarly, the following parameters were renamed, but the methods are only called from our own code, using positional arguments.

• mkdocstrings.handlers.base.BaseHandler.collect(config): Parameter was renamed options
• mkdocstrings.handlers.base.BaseHandler.render(config): Parameter was renamed options

Finally, the following method was removed, but this is again taken into account in our own code:

• mkdocstrings.handlers.base.BaseHandler.get_anchors: Public object was removed

For these reasons, and because we're still in v0, we do not bump to v1 yet. See following deprecations.

Deprecations

mkdocstrings 0.28 will start emitting these deprecations warnings:

The handler argument is deprecated. The handler name must be specified as a class attribute.

Previously, the get_handler function would pass a handler (name) argument to the handler constructor. This name must now be set on the handler's class directly.

class MyHandler:
    name = "myhandler"

The domain attribute must be specified as a class attribute.

The domain class attribute on handlers is now mandatory and cannot be an empty string.

... (truncated)

• 6ef1412 chore: Prepare release 0.28.0
• 936275e Merge branch 'main' of github.com:mkdocstrings/mkdocstrings
• 3cf7d51 fix: Update handlers in JSON schema to be an object instead of an array
• f3ecf58 chore: Ignore autorefs fallback deprecation warning
• 9618e17 docs: Mention mkdocs-api-autonav in recipe
• 52ea2f2 ci: Upgrade dev-deps to prevent warnings in tests
• 8c476ee refactor: Pass config_file_path to get_handler if it expects it
• 053ef23 Merge branch 'main' of github.com:mkdocstrings/mkdocstrings
• 48625a2 chore: Fix inventory loading error log message
• 060e437 docs: Fix link to arithmatex docs in Material for MkDocs
• Additional commits viewable in compare view

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)